home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / XmRendition.z / XmRendition
Text File  |  1998-10-30  |  15KB  |  199 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmRRRReeeennnnddddiiiittttiiiioooonnnn((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmRRRReeeennnnddddiiiittttiiiioooonnnn((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmRRRReeeennnnddddiiiittttiiiioooonnnn - The Rendition registry
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           #include <Xm/Xm.h>
  13.           XmRendition
  14.  
  15.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  16.           This page documents Motif 2.1.
  17.  
  18.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.           XXXXmmmmRRRReeeennnnddddiiiittttiiiioooonnnn is a pseudo widget used for the rendering of
  20.           XXXXmmmmSSSSttttrrrriiiinnnnggggs. XXXXmmmmRRRReeeennnnddddiiiittttiiiioooonnnn has two parts:  XXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaagggg and
  21.           rendering information. The XXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaagggg part can be matched
  22.           with an XXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaagggg associated with a _L_O_C_A_L_E, _C_H_A_R_S_E_T, or
  23.           RRRREEEENNNNDDDDIIIITTTTIIIIOOOONNNN[[[[BBBBEEEEGGGGIIIINNNN||||EEEENNNNDDDD]]]] component within XXXXmmmmSSSSttttrrrriiiinnnngggg.  The
  24.           rendering information contains information about the font or
  25.           fontset, colors, tabs, and lines to be used in rendering a
  26.           text component.
  27.  
  28.           If a resource in a rendition is unspecified, usually by
  29.           setting it to XXXXmmmmAAAASSSS____IIIISSSS or XXXXmmmmUUUUNNNNSSSSPPPPEEEECCCCIIIIFFFFIIIIEEEEDDDD____PPPPIIIIXXXXEEEELLLL, then the value
  30.           to be used for that resource is the value of the immediately
  31.           preceeding rendition in XXXXmmmmSSSSttttrrrriiiinnnngggg. If that value is
  32.           unspecified, then the preceding value is used, and so on. If
  33.           no renditions specify a value for a resource, then a default
  34.           value will be used.
  35.  
  36.         CCCCllllaaaasssssssseeeessss
  37.           XXXXmmmmRRRReeeennnnddddiiiittttiiiioooonnnn does not inherit from any widget class.
  38.  
  39.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  40.           The following table defines a set of widget resources used
  41.           by the programmer to specify data. To reference a resource
  42.           by name or by class in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove the XXXXmmmmNNNN or
  43.           XXXXmmmmCCCCprefix and use the remaining letters. To specify one of
  44.           the defined values for a resource in a ....XXXXddddeeeeffffaaaauuuullllttttssss file,
  45.           remove the XXXXmmmm prefix and use the remaining letters (in
  46.           either lowercase or uppercase, but include any underscores
  47.           between words). The codes in the access column indicate if
  48.           the given resource can be set at creation time (C), set by
  49.           using XXXXmmmmRRRReeeennnnddddiiiittttiiiioooonnnnUUUUppppddddaaaatttteeee (S), retrieved by using
  50.           XXXXmmmmRRRReeeennnnddddiiiittttiiiioooonnnnRRRReeeettttrrrriiiieeeevvvveeee (G), or is not applicable (N/A).
  51.  
  52.                                              XXXXmmmmRRRReeeennnnddddiiiittttiiiioooonnnn RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  53.           NNNNaaaammmmeeee                     CCCCllllaaaassssssss                    TTTTyyyyppppeeee            DDDDeeeeffffaaaauuuulllltttt               AAAAcccccccceeeessssssss
  54.           XmNrenditionBackground   XmCRenditionBackground   Pixel           XmUNSPECIFIED_PIXEL   CSG
  55.           XmNfont                  XmCFont                  XtPointer       XmAS_IS               CSG
  56.           XmNfontName              XmCFontName              String          XmAS_IS               CSG
  57.           XmNfontType              XmCFontType              XmFontType      XmAS_IS               CSG
  58.  
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmRRRReeeennnnddddiiiittttiiiioooonnnn((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmRRRReeeennnnddddiiiittttiiiioooonnnn((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           XmNrenditionForeground   XmCRenditionForeground   Pixel           XmUNSPECIFIED_PIXEL   CSG
  75.           XmNloadModel             XmCLoadModel             unsigned char   XmAS_IS               CSG
  76.           XmNstrikethruType        XmCStrikethruType        unsigned char   XmAS_IS               CSG
  77.           XmNtabList               XmCTabList               XmTabList       XmAS_IS               CSG
  78.           XmNtag                   XmCTag                   XmStringTag     ""                    G
  79.           XmNunderlineType         XmCUnderlineType         unsigned char   XmAS_IS               CSG
  80.  
  81.           XXXXmmmmNNNNrrrreeeennnnddddiiiittttiiiioooonnnnBBBBaaaacccckkkkggggrrrroooouuuunnnndddd
  82.                     Specifies the background drawing color. A value of
  83.                     XXXXmmmmUUUUNNNNSSSSPPPPEEEECCCCIIIIFFFFIIIIEEEEDDDD____PPPPIIIIXXXXEEEELLLL indicates that the background
  84.                     is not specified for this rendition.
  85.  
  86.           XXXXmmmmNNNNffffoooonnnntttt   Specifies the actual font or fontset to be used by
  87.                     this rendition. The value of this resource, if set
  88.                     to other than XXXXmmmmAAAASSSS____IIIISSSS, will be used regardless of
  89.                     the settings of the other font resources. Setting
  90.                     this resource will force XXXXmmmmNNNNllllooooaaaaddddMMMMooooddddeeeellll to be
  91.                     XXXXmmmmLLLLOOOOAAAADDDD____IIIIMMMMMMMMEEEEDDDDIIIIAAAATTTTEEEE. If this resource is not
  92.                     initially set, then it will be set subsequently by
  93.                     the rendition whenever the font or fontset
  94.                     specified by XXXXmmmmNNNNffffoooonnnnttttNNNNaaaammmmeeee is loaded. If both
  95.                     XXXXmmmmNNNNffffoooonnnnttttNNNNaaaammmmeeee and XXXXmmmmNNNNffffoooonnnntttt are specified in a
  96.                     resource file, the XXXXmmmmNNNNffffoooonnnntttt specification will take
  97.                     precedence.
  98.  
  99.           XXXXmmmmNNNNffffoooonnnnttttNNNNaaaammmmeeee
  100.                     Specifies an X Logical Font Description (XLFD)
  101.                     string, which is interpreted either as a font name
  102.                     or as a base font name list. A base font name list
  103.                     is a comma-separated and NULL-terminated string. A
  104.                     value of XXXXmmmmAAAASSSS____IIIISSSS indicates that the font is not
  105.                     specified for this rendition. If both XXXXmmmmNNNNffffoooonnnnttttNNNNaaaammmmeeee
  106.                     and XXXXmmmmNNNNffffoooonnnntttt are specified in a resource file, the
  107.                     XXXXmmmmNNNNffffoooonnnntttt specification will take precedence.
  108.  
  109.           XXXXmmmmNNNNffffoooonnnnttttTTTTyyyyppppeeee
  110.                     Specifies whether the XXXXmmmmNNNNffffoooonnnnttttNNNNaaaammmmeeee resource refers
  111.                     to a font name or to a base font name list. Valid
  112.                     values are XXXXmmmmFFFFOOOONNNNTTTT____IIIISSSS____FFFFOOOONNNNTTTT and XXXXmmmmFFFFOOOONNNNTTTT____IIIISSSS____FFFFOOOONNNNTTTTSSSSEEEETTTT.
  113.  
  114.           XXXXmmmmNNNNrrrreeeennnnddddiiiittttiiiioooonnnnFFFFoooorrrreeeeggggrrrroooouuuunnnndddd
  115.                     Specifies the foreground drawing color. A value of
  116.                     XXXXmmmmUUUUNNNNSSSSPPPPEEEECCCCIIIIFFFFIIIIEEEEDDDD____PPPPIIIIXXXXEEEELLLL indicates that the foreground
  117.                     is not specified for this rendition.
  118.  
  119.           XXXXmmmmNNNNllllooooaaaaddddMMMMooooddddeeeellll
  120.                     Specifies whether the font or fontset specified by
  121.                     XXXXmmmmNNNNffffoooonnnnttttNNNNaaaammmmeeeeis to be loaded when the rendition is
  122.                     created (XXXXmmmmLLLLOOOOAAAADDDD____IIIIMMMMMMMMEEEEDDDDIIIIAAAATTTTEEEE) or only when the font
  123.                     is required to render an XXXXmmmmSSSSttttrrrriiiinnnngggg segment
  124.                     (XXXXmmmmLLLLOOOOAAAADDDD____DDDDEEEEFFFFEEEERRRRRRRREEEEDDDD).  Note that specifying
  125.                     XXXXmmmmLLLLOOOOAAAADDDD____IIIIMMMMMMMMEEEEDDDDIIIIAAAATTTTEEEE for XXXXmmmmNNNNllllooooaaaaddddMMMMooooddddeeeellll is valid only if
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmRRRReeeennnnddddiiiittttiiiioooonnnn((((3333XXXX))))           UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV           XXXXmmmmRRRReeeennnnddddiiiittttiiiioooonnnn((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                     XXXXmmmmNNNNffffoooonnnnttttNNNNaaaammmmeeee is specified, in which case the
  141.                     specified font will be loaded on creation, or if
  142.                     XXXXmmmmNNNNffffoooonnnntttt is specified, in which case the font is
  143.                     already loaded.  XXXXmmmmLLLLOOOOAAAADDDD____DDDDEEEEFFFFEEEERRRRRRRREEEEDDDD is only valid
  144.                     when XXXXmmmmNNNNffffoooonnnnttttNNNNaaaammmmeeee is specified.
  145.  
  146.           XXXXmmmmNNNNssssttttrrrriiiikkkkeeeetttthhhhrrrruuuuTTTTyyyyppppeeee
  147.                     Specifies the type of line to be used to strike
  148.                     through a text segment. Valid values are
  149.                     XXXXmmmmNNNNOOOO____LLLLIIIINNNNEEEE, XXXXmmmmSSSSIIIINNNNGGGGLLLLEEEE____LLLLIIIINNNNEEEE, XXXXmmmmDDDDOOOOUUUUBBBBLLLLEEEE____LLLLIIIINNNNEEEE,
  150.                     XXXXmmmmSSSSIIIINNNNGGGGLLLLEEEE____DDDDAAAASSSSHHHHEEEEDDDD____LLLLIIIINNNNEEEE, and XXXXmmmmDDDDOOOOUUUUBBBBLLLLEEEE____DDDDAAAASSSSHHHHEEEEDDDD____LLLLIIIINNNNEEEE. A
  151.                     value of XXXXmmmmAAAASSSS____IIIISSSS indicates that the strike-through
  152.                     type is not specified for this rendition.
  153.  
  154.           XXXXmmmmNNNNttttaaaabbbbLLLLiiiisssstttt
  155.                     Specifies the tab list to be used in rendering
  156.                     compound strings containing tab components.
  157.  
  158.           XXXXmmmmNNNNttttaaaagggg    Specifies the tag string to be used in matching
  159.                     the renditions with other renditions or with
  160.                     XXXXmmmmSSSSttttrrrriiiinnnnggggTTTTaaaagggg components in _X_m_S_t_r_i_n_g_s. This resource
  161.                     must always be specified. That is, NULL is not a
  162.                     legal value but the empty string is.  This
  163.                     resource is automatically set to the value of the
  164.                     _t_a_g parameter in the XXXXmmmmRRRReeeennnnddddiiiittttiiiioooonnnnCCCCrrrreeeeaaaatttteeee call.
  165.  
  166.           XXXXmmmmNNNNuuuunnnnddddeeeerrrrlllliiiinnnneeeeTTTTyyyyppppeeee
  167.                     Specifies the type of line to be used to underline
  168.                     a text segment.  Valid values are XXXXmmmmNNNNOOOO____LLLLIIIINNNNEEEE,
  169.                     XXXXmmmmSSSSIIIINNNNGGGGLLLLEEEE____LLLLIIIINNNNEEEE, XXXXmmmmDDDDOOOOUUUUBBBBLLLLEEEE____LLLLIIIINNNNEEEE,
  170.                     XXXXmmmmSSSSIIIINNNNGGGGLLLLEEEE____DDDDAAAASSSSHHHHEEEEDDDD____LLLLIIIINNNNEEEE, and XXXXmmmmDDDDOOOOUUUUBBBBLLLLEEEE____DDDDAAAASSSSHHHHEEEEDDDD____LLLLIIIINNNNEEEE. A
  171.                     value of XXXXmmmmAAAASSSS____IIIISSSS indicates that the underline type
  172.                     is not specified for this rendition.
  173.  
  174.      RRRREEEELLLLAAAATTTTEEEEDDDD
  175.           XXXXmmmmRRRReeeennnnddddiiiittttiiiioooonnnnCCCCrrrreeeeaaaatttteeee(3), XXXXmmmmRRRReeeennnnddddiiiittttiiiioooonnnnFFFFrrrreeeeeeee(3),
  176.           XXXXmmmmRRRReeeennnnddddiiiittttiiiioooonnnnRRRReeeettttrrrriiiieeeevvvveeee(3), XXXXmmmmRRRReeeennnnddddiiiittttiiiioooonnnnUUUUppppddddaaaatttteeee(3), and
  177.           XXXXmmmmSSSSttttrrrriiiinnnngggg(3).
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                         (printed 10/24/98)
  196.  
  197.  
  198.  
  199.